home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d18 / tsnap101.arc / TSNAP.DOC < prev    next >
Text File  |  1991-04-28  |  16KB  |  404 lines

  1.  
  2.                                                         Version 1.01
  3.                                                         September 24, 1989
  4.  
  5.  
  6.                                    TSNAP
  7.                                    -----
  8.  
  9.                     Copyright (c) 1989, Future Vision Inc
  10.  
  11.    TSNAP was written by Steve Simpson of Future Vision Inc.  Steve is an 
  12.    independent software engineering consultant with over fifteen years of 
  13.    software experience.
  14.  
  15.    TSNAP is a shareware program.  Please support this program by sending 
  16.    $10 for product registration to:
  17.  
  18.                              Future Vision Inc
  19.                              P.O. Box 34
  20.                              N Billerica, MA 01862
  21.  
  22.                              Tel: (508) 663-8591
  23.  
  24.  
  25.                                What is TSNAP?
  26.                                --------------
  27.  
  28.    TSNAP is a TSR utility that automatically converts editing commands used
  29.    in the "Brief" editor into the editing commands used in both Turbo C and 
  30.    Turbo Pascal.  TSNAP will make your editing in the Turbo Environment 
  31.    easier, faster, and much more productive.  
  32.  
  33.    The Brief Programmer's Editor is published by:
  34.    Solution Systems, 541 Main St, Suite 410, S Weymouth, MA  02190.  
  35.    Tel: (800) 821-2492.  
  36.  
  37.    Brief was written by:
  38.    UnderWare Inc, 321 Columbus Ave, Boston, MA  02116.  
  39.    Tel: (800) 343-7308.
  40.  
  41.    Future Vision Inc has no connection with Solution Systems or UnderWare Inc.
  42.    Please do not contact either of the above two firms with questions about 
  43.    TSNAP.
  44.  
  45.    The TSNAP TSR is completely independent of the Brief editor.  Brief is NOT 
  46.    required to run the TSNAP TSR.
  47.  
  48.  
  49.                                 Trademarks
  50.                                 ----------
  51.  
  52.    Turbo C and Turbo Pascal are trademarks of Borland International.
  53.    Brief is a trademark of UnderWare, Inc.
  54.    UnderWare is a trademark of UnderWare, Inc.
  55.    Solution Systems is a trademark of the Software Developer's Corporation.
  56.  
  57.  
  58.  
  59.    ----------------------------------------------------------------------
  60.    This product  uses the TesSeRact(TM) Ram-Resident Library and supports
  61.    the TesSeRact  Standard for  Ram-Resident Program  Communication.  For
  62.    information about  TesSeRact, contact  the TesSeRact  Development Team
  63.    at:
  64.      
  65.         TesSeRact Development Team
  66.         1657 The Fairways
  67.         Suite 101
  68.         Jenkintown, PA 19046
  69.      
  70.         Phone:              215-884-3373
  71.         CompuServe:         70731,20
  72.         MCIMAIL:            315-5415
  73.         FAX:                215-886-4225
  74.      
  75.    This MCIMAIL  Account has  been provided  to the TesSeRact Development
  76.    Team by Borland International, Inc.  The TesSeRact Development Team is
  77.    in no  way associated with Borland International, Inc.  TesSeRact is a
  78.    trademark of the TesSeRact Development Team.
  79.    ----------------------------------------------------------------------
  80.  
  81.  
  82.                     Installing TSNAP on your system disk
  83.                     ------------------------------------
  84.  
  85.     Copy the TSNAP executable tsnap.exe to a convenient directory on your 
  86.     hard disk.  A good directory to put it in would be one of the "set path"
  87.     directories.  Type "path" on the command line prompt to see the search 
  88.     path the system is using to find executable programs.
  89.  
  90.  
  91.  
  92.                      Installing the TSNAP TSR in memory
  93.                      ----------------------------------
  94.  
  95.     Type "tsnap" on the command line to install TSNAP in memory.
  96.  
  97.     If tsnap.exe was copied to one of your "set path" directories, the 
  98.     operating system will automatically find tsnap.exe on your disk.
  99.  
  100.  
  101.  
  102.                     Removing the TSNAP TSR from memory
  103.                     ----------------------------------
  104.  
  105.     Type "tsnap -r" on the command line to remove TSNAP from memory.
  106.  
  107.     TSNAP cannot remove itself from memory if it detects that you have 
  108.     installed another TSR after TSNAP was installed.  If this is the case, 
  109.     TSNAP will suspend itself and wait until the later TSR is first removed 
  110.     from memory before removing itself.  If the TSNAP TSR is suspended, 
  111.     typing "tsnap" will reactivate the suspended copy of the TSR rather than 
  112.     causing a second copy of TSNAP to be loaded into memory.
  113.  
  114.  
  115.  
  116.                 Automatic detection of Turbo C and Turbo Pascal
  117.                 -----------------------------------------------
  118.  
  119.     Once TSNAP is installed in memory, it lies dormant waiting and watching
  120.     until you execute either Turbo C or Turbo Pascal.  When it detects that 
  121.     you are running either of these programs, it starts looking for Brief 
  122.     editor commands and converts them to the Turbo editor commands.  When 
  123.     you exit Turbo C or Turbo Pascal (with Control-X), TSNAP returns to its 
  124.     dormant state.
  125.  
  126.  
  127.  
  128.                        TSNAP's command line switches
  129.                        ------------------------------
  130.  
  131.     "tsnap       "     Install tsnap TSR into memory.
  132.     "tsnap -r    "     Removes a previously installed copy from memory.
  133.     "tsnap -dpath"     Change temp directory path (40 chars).
  134.                        Default = c:\temp
  135.     "tsnap -fname"     Change temp cutpaste filename (12 chars).
  136.                        Default = cutpaste.dat
  137.     "tsnap -?    "     Command line help.
  138.  
  139.  
  140.  
  141.  
  142.             Notes for non-Brief users.  What will TSNAP do for me?
  143.             ------------------------------------------------------
  144.  
  145.     One of the nicest features of TSNAP is its quick and easy cut and paste
  146.     facility.  With TSNAP, it's a snap to move or copy a chunk of code from 
  147.     one place in a file to another.  With the Alt-N command (Next file), 
  148.     it's just as easy to move or copy from one file to different file as it 
  149.     is move or copy within the same file.
  150.  
  151.     Many simple functions are unbearably messy in the Turbo environment.
  152.     For example, to duplicate a line it is necessary to type "HOME ^K ^B 
  153.     DOWN ^K ^K ^K ^C ^K ^H".  
  154.     With TSNAP duplicating a line is accomplished by simply typing "+ INS".
  155.  
  156.  
  157.  
  158.                  Brief editing commands supported by TSNAP
  159.                  -----------------------------------------
  160.  
  161.  Alt-A          Begin marked area.  Pressing Alt-A again aborts marking.
  162.                 In others words if you begin a marked area with Alt-A and
  163.                 you change your mind, simply press Alt-A again.
  164.  
  165.  -              Cut a line into the save buffer OR cut the marked area into 
  166.                 the save buffer.  (Note: '-' is the keypad '-'.)
  167.  
  168.  +              Save a line in the save buffer OR save the marked area in 
  169.                 the save buffer.  (Note: '+' is the keypad '+'.)
  170.  
  171.  INS            Pastes the save buffer into the file.
  172.  
  173.  DEL            Delete a character OR delete the marked area.
  174.  
  175.  HOME           Home pressed once : moves cursor to the beginning of the line.
  176.                 Home pressed twice (in a row) : moves cursor to the beginning 
  177.                 of the page.
  178.                 Home pressed three times (in a row) : moves cursor to 
  179.                 beginning of the file.
  180.  
  181.  END            End pressed once : moves cursor to the end of the line.
  182.                 End pressed twice (in a row) : moves cursor to end of the 
  183.                 page.
  184.                 End pressed three times (in a row) : moves cursor to end of 
  185.                 the file.
  186.  
  187.  F5             Search forward.
  188.  Alt-F5         Search backward.
  189.  Shift-F5       Search again (in the same direction).
  190.  
  191.  F6             Replace forward.
  192.  Alt-F6         Replace backward.
  193.  Shift-F6       Replace again (in the same direction).
  194.  
  195.  Ctrl-F5        Reverse search/replace case sensitivity (default = ON).
  196.  
  197.                 Global Replace
  198.                 --------------
  199.                 Note: Replace has a new global replace feature.  In addition
  200.                 to answering Y or N during a replace operation, you can now 
  201.                 answer G for a global replace (automatically answer Y).  The 
  202.                 G has effect from the current position to the end of the file 
  203.                 (or to the beginning of the file if you are replacing 
  204.                 backwards).  When a global replace is completed, the cursor 
  205.                 is returned to the file position where the replace first 
  206.                 began.
  207.  
  208.                 It is important to note that with TSNAP's replace you can 
  209.                 perform a global replace from any point in the file to either
  210.                 the beginning or the end of the file.  With Turbo you have no
  211.                 choice, a global replace will perform the replace on the 
  212.                 entire file regardless of your initial file position.
  213.  
  214.                 Turbo's "Replace (Y/N):" on the status line is changed to 
  215.                 "Replace (YGN):" to show that you can also press perform a 
  216.                 global replace.
  217.  
  218.  Alt-D          Delete a line.
  219.  
  220.  Alt-I          Reverse Insert/Overstrike mode.
  221.  
  222.  Alt-K          Delete to the end of the line.
  223.  
  224.  Alt-W          Write the file to disk.
  225.  
  226.  Alt-N          Next file.  You can scan through each of the edit files (if
  227.                 you are editing more than one) by continuing to press Alt-N.
  228.  
  229.                 IMPORTANT FEATURE: With TSNAP it is QUICK and EASY to
  230.                 cut or save a line or an area of your program code from one 
  231.                 file, press Alt-N, and paste it into another file.
  232.  
  233.  Ctrl-U         Scroll text in window up.
  234.  
  235.  Ctrl-D         Scroll text in window down.
  236.  
  237.  Examples:      ("..." in the examples represent cursor movement commands)
  238.  --------
  239.  -                                      Cuts the current line.  The saved line 
  240.                                         may be inserted elsewhere by pressing 
  241.                                         INS.
  242.  
  243.  +                                      Saves the current line.  The saved 
  244.                                         line may be inserted elsewhere by 
  245.                                         pressing INS.
  246.  
  247.  Alt-A ... -                            Cut an area into the save buffer.
  248.  
  249.  Alt-A ... +                            Save an area into the save buffer.
  250.  
  251.  - ... INS                              Moves a line.  (Line cut followed by 
  252.                                         paste).
  253.  
  254.  + ... INS                              Copies a line.  (Line save followed 
  255.                                         by paste).
  256.  
  257.  Alt-A ... - ... INS                    Moves an area.  (Marked area cut 
  258.                                         followed by paste).
  259.  
  260.  Alt-A ... + ... INS                    Copies an area.  (Marked area save 
  261.                                         followed by paste).
  262.  
  263.  Alt-A ... - Alt-N ... INS              Moves an area from one file to 
  264.                                         another.  (Marked area cut in one 
  265.                                         file followed by paste in another
  266.                                         file).
  267.  
  268.  Alt-A ... + Alt-N ... INS              Copies an area from one file to 
  269.                                         another.  (Marked area save in one 
  270.                                         file followed by paste in another
  271.                                         file).
  272.  
  273.  
  274.  
  275.         Notes for Brief users.  Differences between TSNAP and Brief
  276.         -----------------------------------------------------------
  277.  
  278.     Marking a block and pressing DEL does a cut of the marked area INTO 
  279.     THE SAVE BUFFER.  (Brief deletes the marked area without touching the 
  280.     save buffer).
  281.     We changed the way this works because there presently is no UNDO 
  282.     capability.  It was simply too easy to accidently press DEL instead 
  283.     of + with the result that instead of saving the block you would have 
  284.     PERMANENTLY lost it.  
  285.  
  286.     Note: Alt-D does works the same as in Brief: it deletes the line without 
  287.     touching the save buffer.
  288.  
  289.  
  290.  
  291.                   Turbo's F5, F6, Alt-F5, Alt-F6 keys
  292.                   -----------------------------------
  293.  
  294.     Both TSNAP and Turbo's editor use the F5, F6, Alt-F5, Alt-F6, keys.  In 
  295.     TSNAP, the keys mean: search forward, search backward, replace forward, 
  296.     and replace backward.  In Turbo, the keys mean: zoom, switch, user 
  297.     screen, and swap.  To execute the Turbo meaning of the keys, simply 
  298.     press the key twice (in a row).  For example, pressing F5 starts a 
  299.     string search, pressing F5 F5 performs the Turbo zoom function.
  300.  
  301.  
  302.  
  303.                           Future enhancements
  304.                           -------------------
  305.  
  306.     We hope to add a limited UNDO capability, bookmarks, "Alt -" (the 
  307.     reverse of Alt N), and keyboard macros.
  308.  
  309.     We would like hear your ideas and suggestions on how to improve TSNAP.
  310.     Please contact us at the address listed at the top of this document.
  311.  
  312.  
  313.  
  314.                               Temporary files
  315.                               ---------------
  316.  
  317.     TSNAP uses the temporary file c:\temp\cutpaste.dat as a cutpaste buffer.
  318.  
  319.     The default directory (c:\temp) can be changed with the -dname switch 
  320.     on the command line.  The default cutpaste buffer filename (cutpaste.dat) 
  321.     can be changed with the -fname switch on the command line.  
  322.     Example: "tsnap -dc:\tc\temp" will change the default TSNAP directory.
  323.  
  324.     When TSNAP is first installed in memory, it creates the temporary 
  325.     directory and file if it does not already exist.  The temporary file 
  326.     must already exist before performing any cutting or pasting during 
  327.     your editing.  
  328.     If your change the default temporary directory with the -d command line 
  329.     switch, the disk name should always be specified as part of the 
  330.     directory path.
  331.  
  332.  
  333.  
  334.                   TSNAP's Temporary Use of Placement Markers
  335.                   ------------------------------------------
  336.  
  337.     The Turbo Pascal and Turbo C editors have four place markers (0 
  338.     through 3).  TSNAP uses markers 2 and 3 whenever you press Alt-A and 
  339.     mark backwards through the text.  Place marker 3 is used whenever you 
  340.     perform a replace operation.  
  341.  
  342.     Place markers 0 and 1 are presently not used by TSNAP.
  343.  
  344.  
  345.  
  346.                            TSNAP Version History
  347.                            ---------------------
  348.  
  349.     1.01 9/24/89
  350.     Added on/off choices to popup menu.  The automatic detection of Turbo 
  351.     Pascal/C only works for DOS version 3 and up.  The on/off menu choices 
  352.     allow TSNAP to be used with DOS 2 users.
  353.  
  354.     1.00 9/20/89
  355.     Initial release.
  356.  
  357.  
  358.  
  359.                              Quick Reference
  360.                              ---------------
  361.  
  362.  -                      Cut a line or marked area.
  363.  +                      Save a line or marked area.
  364.  Alt-A                  Start marking an area.  Alt-A aborts.
  365.  Alt-A ... -            Cut an area.
  366.  Alt-A ... +            Save an area.
  367.  INS                    Paste.
  368.  DEL                    Delete char or marked area.
  369.  
  370.  HOME                   Goto beginning of the line.
  371.  HOME HOME              Goto beginning of the page.
  372.  HOME HOME HOME         Goto beginning of the file.
  373.  
  374.  END                    Goto end of the line.
  375.  END END                Goto end of the page.
  376.  END END END            Goto end of the file.
  377.  
  378.  F5                     Search forward.
  379.  Alt-F5                 Search backward.
  380.  Shift-F5               Search again (in the same direction).
  381.  
  382.  F6                     Replace forward.
  383.  Alt-F6                 Replace backward.
  384.  Shift-F6               Replace again (in the same direction).
  385.  
  386.  Ctrl-F5                Reverse case sensitivity (default = ON).
  387.  
  388.  F5 F5                  Turbo's zoom command.
  389.  ALT-F5 ALT-F5          Turbo's switch command.
  390.  F6 F6                  Turbo's user screen command.
  391.  ALT-F6 ALT-F6          Turbo's swap command.
  392.  
  393.  Alt-D                  Delete a line.
  394.  Alt-K                  Delete (Kill) to the end of the line.
  395.  
  396.  Alt-I                  Reverse Insert/Overstrike mode.
  397.  
  398.  Alt-W                  Write file.
  399.  Alt-N                  Next file.
  400.  
  401.  Ctrl-U                 Scroll text in window up.
  402.  Ctrl-D                 Scroll text in window down.
  403.  
  404.